---
title: "dub.workspaces.get"
sidebarTitle: "Get"
"og:title": "dub.workspaces.get - Retrieve a workspace - TypeScript SDK"
description: "Retrieve a workspace for the authenticated user."
---

import WorkspaceResponse from "/snippets/workspace-response.mdx";

## Arguments

<ParamField body="idOrSlug" type="string" required>
  The unique ID or slug of the workspace.
</ParamField>

## Response

<WorkspaceResponse />

<RequestExample>

```ts
// Retrieve a workspace by ID
await dub.workspaces.get({
  idOrSlug: "clv3mw4qb00008tvuw86c53db,
});

// Retrieve a workspace by slug
await dub.workspaces.get({
  idOrSlug: "acme",
});
```

</RequestExample>

<ResponseExample>

```ts
{
  id: 'clv3mw4qb00008tvuw86c53db',
  name: 'Acme',
  slug: 'acme',
  logo: null,
  usage: 0,
  usageLimit: 1000,
  linksUsage: 0,
  linksLimit: 25,
  domainsLimit: 3,
  tagsLimit: 5,
  usersLimit: 1,
  plan: 'free',
  stripeId: null,
  billingCycleStart: 17,
  createdAt: '2024-04-17T09:52:27.635Z',
  users: [ { role: 'owner' } ],
  domains: []
}
```

</ResponseExample>
